home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / claqhb.z / claqhb
Encoding:
Text File  |  2002-10-03  |  4.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4. CCCCLLLLAAAAQQQQHHHHBBBB((((3333SSSS))))                                                          CCCCLLLLAAAAQQQQHHHHBBBB((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CLAQHB - equilibrate a symmetric band matrix A using the scaling factors
  10.      in the vector S
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CLAQHB( UPLO, N, KD, AB, LDAB, S, SCOND, AMAX, EQUED )
  14.  
  15.          CHARACTER      EQUED, UPLO
  16.  
  17.          INTEGER        KD, LDAB, N
  18.  
  19.          REAL           AMAX, SCOND
  20.  
  21.          REAL           S( * )
  22.  
  23.          COMPLEX        AB( LDAB, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CLAQHB equilibrates a symmetric band matrix A using the scaling factors
  40.      in the vector S.
  41.  
  42. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  43.      UPLO    (input) CHARACTER*1
  44.              Specifies whether the upper or lower triangular part of the
  45.              symmetric matrix A is stored.  = 'U':  Upper triangular
  46.              = 'L':  Lower triangular
  47.  
  48.      N       (input) INTEGER
  49.              The order of the matrix A.  N >= 0.
  50.  
  51.      KD      (input) INTEGER
  52.              The number of super-diagonals of the matrix A if UPLO = 'U', or
  53.              the number of sub-diagonals if UPLO = 'L'.  KD >= 0.
  54.  
  55.      AB      (input/output) COMPLEX array, dimension (LDAB,N)
  56.              On entry, the upper or lower triangle of the symmetric band
  57.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  58.              column of A is stored in the j-th column of the array AB as
  59.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCLLLLAAAAQQQQHHHHBBBB((((3333SSSS))))                                                          CCCCLLLLAAAAQQQQHHHHBBBB((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  75.              j<=i<=min(n,j+kd).
  76.  
  77.              On exit, if INFO = 0, the triangular factor U or L from the
  78.              Cholesky factorization A = U'*U or A = L*L' of the band matrix A,
  79.              in the same storage format as A.
  80.  
  81.      LDAB    (input) INTEGER
  82.              The leading dimension of the array AB.  LDAB >= KD+1.
  83.  
  84.      S       (output) REAL array, dimension (N)
  85.              The scale factors for A.
  86.  
  87.      SCOND   (input) REAL
  88.              Ratio of the smallest S(i) to the largest S(i).
  89.  
  90.      AMAX    (input) REAL
  91.              Absolute value of largest matrix entry.
  92.  
  93.      EQUED   (output) CHARACTER*1
  94.              Specifies whether or not equilibration was done.  = 'N':  No
  95.              equilibration.
  96.              = 'Y':  Equilibration was done, i.e., A has been replaced by
  97.              diag(S) * A * diag(S).
  98.  
  99. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  100.      THRESH is a threshold value used to decide if scaling should be done
  101.      based on the ratio of the scaling factors.  If SCOND < THRESH, scaling is
  102.      done.
  103.  
  104.      LARGE and SMALL are threshold values used to decide if scaling should be
  105.      done based on the absolute size of the largest matrix element.  If AMAX >
  106.      LARGE or AMAX < SMALL, scaling is done.
  107.  
  108. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  109.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  110.  
  111.      This man page is available only online.
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.